home *** CD-ROM | disk | FTP | other *** search
/ MacAddict 103 / MacAddict_103_2005-03.iso / Software / Internet & Communication / MacBiff 1.1.11.dmg / MacBiff.app / Contents / Resources / README.txt < prev   
Encoding:
Text File  |  2005-01-01  |  6.0 KB  |  125 lines
  1. /*
  2.  * $Id: README.txt 95 2004-10-19 04:08:31Z bmoore $
  3.  *
  4.  * Copyright (c) 2004  Branden J. Moore.
  5.  *
  6.  * This file is part of MacBiff, and is free software; you can redistribute
  7.  * it and/or modify it under the terms of the GNU General Public License as
  8.  * published by the Free Software Foundation; either version 2 of the
  9.  * License, or (at your option) any later version.
  10.  *
  11.  * MacBiff is distributed in the hope that it will be useful, but WITHOUT
  12.  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13.  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14.  * more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License along
  17.  * with MacBiff; if not, write to the Free Software Foundation, Inc., 59
  18.  * Temple Place, Suite 330, Boston, MA  02111-1307 USA.
  19.  *
  20.  */
  21.  
  22. SUMMARY:
  23. ===========================================================================
  24.         MacBiff is a Mac OSX 10.3 (and higher) compliant "biff" program.
  25. Its job is to report to the user when they receive new email, and where that
  26. email is.
  27.  
  28. CONFIGURATION:
  29. ===========================================================================
  30.         The MacBiff Setup window is split in to three parts: Servers, Alerts
  31. and Options.
  32.         Servers shows a list of the configured IMAP servers, and gives you
  33. the ability to enable/disable them, or add/remove/edit them.
  34.         The Alerts tab allows you to configure how you would like to be
  35. notified of new mail.  You can have MacBiff display the count of messages in
  36. text, or display a small graphic.  The text can change color to notify you
  37. of new mail, and you can choose to have a system sound be played.  As of
  38. version 1.1.9, there is support for Growl Notification (see http://growl.info)
  39. There is also the option of executing a shell command whenever new mail is 
  40. received.  If you enter a command into this textbox, the following "special" 
  41. codes are replaced accordingly:
  42.     %m = mailbox name
  43.     %p = full mailbox path name
  44.     %t = total number of messages in the mailbox
  45.     %u = number of unread messages in the mailbox
  46.     %n = new unread messages in the mailbox
  47.  
  48.         The Options tab allows you to set various options that control how
  49. MacBiff works.
  50.   * Check Mail Delay: Select how often you wish MacBiff to check for new mail.
  51.   * Include "Ignored" Folders in count:  Determins if new messages in
  52.         "ignored" folders should be used to calculate new message counts.
  53.   * Fetch Unread Headers:  Choose to download the headers of unread messages.
  54.   * Fetch Unread Headers in "Ignored" Folders:  (self explanitory)
  55.   * Display Activity Window on "Check Now":  (self explanitory)
  56.   * Mail Application:  Command to run when "Launch Mail" is chosen from the
  57.         menu.
  58.  
  59.  
  60. The Connection Setup window for each configured server shows a listing of
  61. options on the left, and a folder listing on the right.
  62.  
  63.   * Server Identifier:  This is the "Title" of the server configuration.
  64.   * Server Name:  This is the IP name of the mail server.
  65.   * User Name:  This is the login name of the user.
  66.   * Password:  Login password.
  67.   * Path Prefix:  Set this only if needed, to specify where your IMAP folders
  68.         are located.
  69.   * Use SSL:  Enabled by default.  You should be using SSL.  This causes
  70.         MacBiff to connect to your IMAP/SSL server on port 993.
  71.   * Save Password:  Enabled by default.  Saves your password in the OSX
  72.         Keychain.
  73.   * Enabled:  Set to enable/disable checking this account.
  74.  
  75. The Folder listing on the right is empty until you first check mail.  It
  76. shows the folders that it knows about.  If you check the "Ignore" box for
  77. a folder, that folder will not be used to determine if New Mail notification
  78. should be notification should be issued.  If you check the "Disabled" box
  79. for a folder, that folder will not be checked at all.
  80.  
  81.  
  82. USAGE:
  83. ===========================================================================
  84.         MacBiff will then go out and query the IMAP server for your email.
  85. It will display in the menu-bar the amount of unread email, as well as the
  86. total amount of email you have on the server in the form [#unread / #total].
  87.  
  88. In the dropdown menu, there are options to:
  89.   * Check Now:            Force MacBiff to update immediately.
  90.   * Configure:            Brings up the configuration dialog.
  91.   * Detatch:              Opens a window showing your mail folders.
  92.   * Show Activity:      Opens an Activity window.
  93.   * Launch Mail:          Launches configured mail application.
  94.   * About MacBiff:        Opens an About Dialog
  95.   * Quit MacBiff:         Quits MacBiff
  96.  
  97. Below these options are your mailboxes.  If you have no new email, no
  98. mailboxes will be shown.  Mailboxes with unseen email will show up (along
  99. with their parents) with a checkbox next to them.  If you un-check the
  100. checkbox, that folder will no longer be used to determine if the New Mail
  101. notification should be used, but will still be displayed.  If you have
  102. "Fetch Unread Headers" selected, a listing of the new mail will be shown as
  103. a sub-menu to the folder.
  104.  
  105. If you have no unread mail (or only unread mail in un-checked folders),
  106. MacBiff will display in black letters in the System Menu Bar.  If you do
  107. have unread email, MacBiff will display in Red.  Also, a system beep will be
  108. sounded to alert you to the new mail.
  109.  
  110. ABOUT MACBIFF:
  111. ===========================================================================
  112.         MacBiff was created in early 2004 to solve the problem of mixing
  113. procmail with pine.  Mail gets delivered to non "Inbox" folders, which pine
  114. would not notice, thus necessitating a search for new mail.  With MacBiff, I
  115. am notified when mail arrives, and what folders it has been delivered to.
  116. This also works well with Mail.app, which tends to not automatically
  117. syncronize folders (even when asked).
  118.  
  119. AUTHOR:
  120. ===========================================================================
  121.         MacBiff was written by Branden J. Moore <bmoore@forkit.org>, with
  122. contributions from Mr. Wheeler, Mr. Pollet, Mr. Babin and Mac-arena the Bored
  123. Zo.  Thanks to Dr. Anderson for his help in debugging.
  124.  
  125.